home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 2002 November / SGI IRIX Base Documentation 2002 November.iso / usr / share / catman / p_man / cat3 / librw / RWSlistCollectablesQueue.z / RWSlistCollectablesQueue
Encoding:
Text File  |  2002-10-03  |  9.8 KB  |  199 lines
  1.  
  2.  
  3.  
  4. RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))                  RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))
  5.  
  6.  
  7.  
  8. NNNNaaaammmmeeee
  9.      RWSlistCollectablesQueue - Rogue Wave library class
  10.  
  11. SSSSyyyynnnnooooppppssssiiiissss
  12.               // Smalltalk typedef:
  13.  
  14.  
  15.  
  16.               typedef RWSlistCollectablesQueue Queue ;
  17.           #include <rw/queuecol.h>
  18.           RWSlistCollectablesQueue a;
  19.  
  20.  
  21.  
  22.  
  23. DDDDeeeessssccccrrrriiiippppttttiiiioooonnnn
  24.      Class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee represents a restricted interface to class
  25.      RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss to implement a first in first out (FIFO) queue.  A
  26.      qqqquuuueeeeuuuueeee is a sequential list for which all insertions are made at one end
  27.      (the "tail"), but all removals are made at the other end (the "head").
  28.      Hence, the ordering is determined externally by the ordering of the
  29.      insertions.  Duplicates are allowed.  An object stored by
  30.      RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee must inherit abstract base class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee.
  31.      The virtual function iiiissssEEEEqqqquuuuaaaallll(((()))) (see class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee) is required, to
  32.      find a match between a target and an item in the queue.  This class
  33.      corresponds to the Smalltalk class QQQQuuuueeeeuuuueeee.
  34.  
  35. PPPPeeeerrrrssssiiiisssstttteeeennnncccceeee
  36.      Polymorphic
  37.  
  38. PPPPuuuubbbblllliiiicccc CCCCoooonnnnssssttttrrrruuuuccccttttoooorrrrssss
  39.               RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee();
  40.  
  41.  
  42.      Construct an empty queue.
  43.  
  44.               RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee(RWCollectable* a);
  45.  
  46.  
  47.      Construct an queue with single item a.
  48.  
  49.               RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee(const RWSlistCollectablesQueue & q);
  50.  
  51.  
  52.      Copy constructor.  A shallow copy of the queue qqqq is made.
  53.  
  54. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr OOOOppppeeeerrrraaaattttoooorrrrssss
  55.               void
  56.           ooooppppeeeerrrraaaattttoooorrrr====(const RWSlistCollectablesQueue & q);
  57.  
  58.  
  59.  
  60.  
  61.  
  62.  
  63.                                                                         PPPPaaaaggggeeee 1111
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70. RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))                  RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))
  71.  
  72.  
  73.  
  74.      Assignment operator.  A shallow copy of the queue qqqq is made.
  75.  
  76. PPPPuuuubbbblllliiiicccc MMMMeeeemmmmbbbbeeeerrrr FFFFuuuunnnnccccttttiiiioooonnnnssss
  77.               virtual void
  78.           aaaappppppppllllyyyy(RWapplyCollectable ap, void*);
  79.  
  80.  
  81.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.
  82.  
  83.               virtual RWCollectable*
  84.           aaaappppppppeeeennnndddd(RWCollectable*);
  85.  
  86.  
  87.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.  Adds an element to the end of
  88.      the queue.
  89.  
  90.               virtual RWspace
  91.           bbbbiiiinnnnaaaarrrryyyySSSSttttoooorrrreeeeSSSSiiiizzzzeeee() const;
  92.  
  93.  
  94.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  95.  
  96.               virtual void
  97.           cccclllleeeeaaaarrrr();
  98.  
  99.  
  100.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.
  101.  
  102.               virtual void
  103.           cccclllleeeeaaaarrrrAAAAnnnnddddDDDDeeeessssttttrrrrooooyyyy();
  104.           virtual RWBoolean
  105.           ccccoooonnnnttttaaaaiiiinnnnssss(const RWCollectable* target) const;
  106.  
  107.  
  108.      Inherited from class RRRRWWWWCCCCoooolllllllleeeeccccttttiiiioooonnnn.
  109.  
  110.               RWBoolean
  111.           ccccoooonnnnttttaaaaiiiinnnnssssRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e) const;
  112.           virtual size_t
  113.           eeeennnnttttrrrriiiieeeessss() const;
  114.  
  115.  
  116.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.
  117.  
  118.               virtual RWCollectable*
  119.           ffffiiiirrrrsssstttt() const;
  120.  
  121.  
  122.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.  Returns the item at the
  123.      beginning of the queue (iiii....eeee...., the least recently inserted item).  Returns
  124.      nnnniiiillll if the queue is empty.
  125.  
  126.  
  127.  
  128.  
  129.                                                                         PPPPaaaaggggeeee 2222
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136. RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))                  RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessssQQQQuuuueeeeuuuueeee((((3333CCCC++++++++))))
  137.  
  138.  
  139.  
  140.               RWCollectable*
  141.           ggggeeeetttt();
  142.  
  143.  
  144.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.  Returns and rrrreeeemmmmoooovvvveeeessss the item
  145.      at the beginning of the queue (iiii....eeee...., the least recently inserted item).
  146.      Returns nnnniiiillll if the queue is empty.
  147.  
  148.               virtual RWCollectable*
  149.           iiiinnnnsssseeeerrrrtttt(RWCollectable* c);
  150.  
  151.  
  152.      Redefined from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss to call aaaappppppppeeeennnndddd(((()))).
  153.  
  154.               virtual RWClassID
  155.           iiiissssAAAA() const;
  156.  
  157.  
  158.      Redefined from class RRRRWWWWCCCCoooolllllllleeeeccccttttaaaabbbblllleeee to return ________RRRRWWWWSSSSLLLLIIIISSSSTTTTCCCCOOOOLLLLLLLLEEEECCCCTTTTAAAABBBBLLLLEEEESSSSQQQQUUUUEEEEUUUUEEEE.
  159.  
  160.               virtual RWBoolean
  161.           iiiissssEEEEmmmmppppttttyyyy() const;
  162.  
  163.  
  164.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.
  165.  
  166.               virtual RWCollectable*
  167.           llllaaaasssstttt() const;
  168.  
  169.  
  170.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.  Returns the last item in the
  171.      queue (the most recently inserted item).
  172.  
  173.               virtual size_t
  174.           ooooccccccccuuuurrrrrrrreeeennnncccceeeessssOOOOffff(const RWCollectable* target) const;
  175.           size_t
  176.           ooooccccccccuuuurrrrrrrreeeennnncccceeeessssOOOOffffRRRReeeeffffeeeerrrreeeennnncccceeee(const RWCollectable* e) const;
  177.  
  178.  
  179.      Inherited from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.
  180.  
  181.               virtual RWCollectable*
  182.           rrrreeeemmmmoooovvvveeee(const RWCollectable*);
  183.  
  184.  
  185.      Redefined from class RRRRWWWWSSSSlllliiiissssttttCCCCoooolllllllleeeeccccttttaaaabbbblllleeeessss.  Calls ggggeeeetttt(((()))).  The argument is
  186.      ignored.
  187.  
  188.  
  189.  
  190.  
  191.  
  192.  
  193.  
  194.  
  195.                                                                         PPPPaaaaggggeeee 3333
  196.  
  197.  
  198.  
  199.